package com.mfizz.binlog;

/*
 * #%L
 * mfz-binlog
 * %%
 * Copyright (C) 2012 mfizz
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

/**
 * Convert between byte arrays and objects for writing and reading from a
 * binlog record.
 * 
 * @author mfizz
 */
public interface BinlogRecordTranscoder<E> {
    
    /**
     * Encode the given object to a byte array for writing.
     *
     * @param obj The object to encode into a byte array
     * @return the byte array representation of the object
     */
    public byte[] encode(E obj) throws BinlogException;

    /**
     * Decode the byte array into an object it represents.
     *
     * @param header The header of the record associated with this data
     * @param data The byte array to decode into an object
     * @return the object
     */
    public E decode(byte[] data) throws BinlogException;
    
}
